docs(pdk-migration): update guide for @aws/nx-plugin 1.0.0-rc.33#787
Open
nx-plugin-for-aws wants to merge 6 commits into
Open
docs(pdk-migration): update guide for @aws/nx-plugin 1.0.0-rc.33#787nx-plugin-for-aws wants to merge 6 commits into
nx-plugin-for-aws wants to merge 6 commits into
Conversation
Contributor
|
📚 Documentation translations have been updated and committed (562b566) to this PR. |
Use a string module id instead of a regex literal for the ace-builds external entry. The regex literal inside the diff code block was mangled by the documentation translation step, producing invalid MDX in translated files and breaking the docs build.
Contributor
|
📚 Documentation translations have been updated and committed (314ee90) to this PR. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #787 +/- ##
==========================================
+ Coverage 87.22% 87.71% +0.48%
==========================================
Files 140 157 +17
Lines 4987 5788 +801
Branches 1164 1377 +213
==========================================
+ Hits 4350 5077 +727
- Misses 338 362 +24
- Partials 299 349 +50 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
- Bump the pinned version from 1.0.0-rc.10 to 1.0.0-rc.33 - Drop the manual tsx install step: ts#smithy-api vends tsx as a dev dependency since #786 - Rename the serve-local target to dev following #806 - Pass ux=cloudscape to ts#website since the default changed to shadcn in #854 (the shopping list app uses CloudScape components) - Fix the vite.config.mts outDir shown in the ace-builds diff context to match the generated config (bundle subdirectory) Validated by running the full migration end-to-end on a fresh 1.0.0-rc.33 workspace, including a live AWS deploy, authenticated GET/POST/DELETE API tests and teardown.
nx-plugin-for-aws
changed the title
Contributor
|
📚 Documentation translations have been updated and committed (819057a) to this PR. |
nx-plugin-for-aws
force-pushed
the
docs/pdk-migration-rc
branch
from
819057a to
c8cbae8
Compare
Contributor
|
📚 Documentation translations have been updated and committed (8aaf5ed) to this PR. |
nx-plugin-for-aws
force-pushed
the
docs/pdk-migration-rc
branch
from
8aaf5ed to
9d075db
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Reason for this change
The PDK migration guide was pinned to
@aws/nx-plugin@0.50.0and used an old workspace-creation command and pre-1.0 generator names. This validates and updates the guide against the latest1.0.0-rc.33release.I performed a full real migration of the shopping-list tutorial app end-to-end on
1.0.0-rc.33— including a live AWS deploy, an authenticated end-to-end API test, and teardown — to confirm every step.Description of changes
create-nx-workspace --presetTabs with the documented<CreateNxWorkspaceCommand>component, pinned to1.0.0-rc.33via thetagprop (removed now-unusedTabs/TabItemimport).0.50.0to1.0.0-rc.33in the point-in-time callout.ts#apientry point withframework: 'smithy'(instead ofts#smithy-apidirectly), and lowercaseauth: 'iam'(the enum is now lowercase).ts#website(framework: 'react',ux: 'cloudscape'— the default UX provider changed to shadcn in feat(ts#website): default ux provider to shadcn instead of cloudscape #854 and the shopping list app uses CloudScape) andts#website#authentry points (instead ofts#react-website/ts#react-website#auth). Same fix applied to the Type Safe API FAQ snippet.Echooperation handler (backend/src/operations/echo.ts), which otherwise breaks the build once the operation is removed from the model.@aws-northstar/ui+ace-builds: added a manual step to excludeace-builds/webpack-resolverfrom the Vite bundle. Northstar bundles a code editor that uses a webpack-specific import which the current Vite/Rolldown bundler can't resolve; the shopping-list app doesn't use that component, so we externalise it. This is documented as a manual tutorial step under "Add AWS Northstar Dependency" since Northstar isn't part of the website generator. (Re-verified still required on1.0.0-rc.33.)devtarget (theserve-localtarget was removed in favour ofdevin feat(nx-plugin): migrate to Nx 23 and standardize on dev target #806). The manualtsxinstall step was dropped sincets#smithy-apivendstsxas a dev dependency as of fix(ts#smithy-api): add tsx as a dev dependency #786.Description of how you validated changes
pnpm create @aws/nx-workspace@1.0.0-rc.33workspace using the exact documented commands.nx run-many --target buildpasses for all projects.nx dev websiteruns both the website (4200) and Smithy API (3001) local servers.nx build docs) — all pages render without errors.Issue # (if applicable)
N/A
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license